home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audiofile / afGetFormatParams.z / afGetFormatParams
Encoding:
Text File  |  2002-10-03  |  8.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaaffffGGGGeeeettttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                                  aaaaffffGGGGeeeettttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afGetFormatParams - get the audio data format in an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee for a
  10.      specified audio track via ddddmmmmPPPPaaaarrrraaaammmmssss
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____aaaauuuuddddiiiioooo....hhhh>>>>
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  15.  
  16.      DDDDMMMMssssttttaaaattttuuuussss aaaaffffGGGGeeeettttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt ttttrrrraaaacccckkkk,,,,
  17.                                 DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  18.  
  19. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  20.      _f_i_l_e     is an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure, previously created by a call to
  21.               aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm) or aaaaffffOOOOppppeeeennnnFFFFDDDD(3dm).
  22.  
  23.      _t_r_a_c_k    is an integer which identifies an audio track in _h_a_n_d_l_e.
  24.  
  25.               Since all currently supported file formats contain only one
  26.               audio track, the value AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK should used here for
  27.               now.
  28.  
  29.      _p_a_r_a_m_s   a DDDDMMMMppppaaaarrrraaaammmmssss list, previously created by a call to
  30.               ddddmmmmPPPPaaaarrrraaaammmmssssCCCCrrrreeeeaaaatttteeee(3dm).
  31.  
  32. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  33.      aaaaffffGGGGeeeettttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) retrieves all parameters associated with the audio
  34.      data in an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure for an audio track.  It obsoletes the
  35.      individual routines aaaaffffGGGGeeeettttSSSSaaaammmmpppplllleeeeFFFFoooorrrrmmmmaaaatttt(3dm), aaaaffffGGGGeeeettttCCCChhhhaaaannnnnnnneeeellllssss(3dm),
  36.      aaaaffffGGGGeeeettttRRRRaaaatttteeee(3dm), aaaaffffGGGGeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(3dm), and aaaaffffGGGGeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnnPPPPaaaarrrraaaammmmssss(3dm).
  37.  
  38.      The following parameters are defined in _d_m_e_d_i_a/_d_m__a_u_d_i_o._h and may be
  39.      retrieved from _p_a_r_a_m_s:
  40.  
  41.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFOOOORRRRMMMMAAAATTTT       Sample format.  Will be DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____TTTTWWWWOOOOSSSS____CCCCOOOOMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTT,
  42.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD, DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFLLLLOOOOAAAATTTT, or
  43.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____DDDDOOOOUUUUBBBBLLLLEEEE.
  44.  
  45.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____WWWWIIIIDDDDTTTTHHHH        Sample width in bits.  For integer sample formats,
  46.                            it will be an integer value between 1 and 32.  For
  47.                            format DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFLLLLOOOOAAAATTTT it will be 32, and for
  48.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____DDDDOOOOUUUUBBBBLLLLEEEE it will be 64.
  49.  
  50.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCHHHHAAAANNNNNNNNEEEELLLLSSSS     Channel count.
  51.  
  52.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____RRRRAAAATTTTEEEE         Sampling rate.
  53.  
  54.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOOMMMMPPPPRRRREEEESSSSSSSSIIIIOOOONNNN  Compression type.  Will be DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____UUUUNNNNCCCCOOOOMMMMPPPPRRRREEEESSSSSSSSEEEEDDDD or
  55.                            one of the supported compression parameter values.
  56.                            In addition, any parameters associated with the
  57.                            compression, such as DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____BBBBIIIITTTTRRRRAAAATTTTEEEE, will also be
  58.                            retrievable here (see aaaaffffGGGGeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(3dm) and
  59.                            aaaaffffGGGGeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnnPPPPaaaarrrraaaammmmssss(3dm)).
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffGGGGeeeettttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                                  aaaaffffGGGGeeeettttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____SSSSLLLLOOOOPPPPEEEE
  75.  
  76.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____IIIINNNNTTTTEEEERRRRCCCCEEEEPPPPTTTT
  77.  
  78.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____MMMMAAAAXXXXCCCCLLLLIIIIPPPP
  79.  
  80.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____MMMMIIIINNNNCCCCLLLLIIIIPPPP
  81.                            Slope, intercept, minimum and maximum clipping
  82.                            values for PCM mapping (see
  83.                            aaaaffffGGGGeeeettttVVVViiiirrrrttttuuuuaaaallllPPPPCCCCMMMMMMMMaaaappppppppiiiinnnngggg(3dm) for a detailed
  84.                            explanation).
  85.  
  86.      When a file is opened for reading via a call to aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm), the
  87.      track will contain a full description of the audio data format, including
  88.      data type, sample width, number of channels, sample rate, compression and
  89.      any associated parameters, and PCM mapping information.
  90.  
  91. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  92.      Note that this library will continue to support new file formats and thus
  93.      other data formats than the ones described above.  Since the Audio File
  94.      Library is a Dynamic Shared Object (DSO), it is possible for this call to
  95.      return parameter values not found in <ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____aaaauuuuddddiiiioooo....hhhh> at the time of
  96.      programming.  Programs should be written to at least reject files with
  97.      formats they are not written to handle.
  98.  
  99. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  100.      afOpenFile(3dm), afReadFrames(3dm), afWriteFrames(3dm),
  101.      afInitFormatParams(3dm), afSetVirtualFormatParams(3dm),
  102.      afGetConversionParams(3dm)
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.